Human resource APIs
Totals including open periods for a given workday
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/work-days/{workDayId}/totals-including-open-periods |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {workDayId} |
Workday identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 4060, version 1 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ScheduledWorkingHours
Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.
>{Decimal}</ScheduledWorkingHours>WorkHours
Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.
>{Decimal}</WorkHours>RegularHours
Total work time, in hours, for all periods in this work hour log.
>{Decimal}</RegularHours>OvertimeHours
Total overtime, in hours, of all periods in this work hour log.
>{Decimal}</OvertimeHours>PaidAbscenceHours
Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.
>{Decimal}</PaidAbscenceHours>UnpaidAbscenceHours
Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.
>{Decimal}</UnpaidAbscenceHours>LunchHours
Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.
>{Decimal}</LunchHours>FlexHours
Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.
>{Decimal}</FlexHours>ScheduledWorkingHours
Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.
": "{Decimal}",WorkHours
Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.
": "{Decimal}",RegularHours
Total work time, in hours, for all periods in this work hour log.
": "{Decimal}",OvertimeHours
Total overtime, in hours, of all periods in this work hour log.
": "{Decimal}",PaidAbscenceHours
Total paid leave/absence, in hours, for all periods in this work hour log. Ex. vacation, paid sick leave and/or parental leave.
": "{Decimal}",UnpaidAbscenceHours
Total unpaid leave/absence, in hours, for all periods in this work hour log. Ex. day off or unpaid short time leave.
": "{Decimal}",LunchHours
Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.
": "{Decimal}",FlexHours
Change/difference in flextime account. Calculated by substracting ordinary work and paid- and unpaid absence from scheduled hours. Will only be set if status is 4 or more, and work arrangement allows flexitime. Will not be set if work hour log contains any periods with partial- or graded sick leave.
": "{Decimal}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100511 HTTP 400 | Invalid date |
| Error 100537 HTTP 400 | Could not find work arrangements for employee {0} on date {1} |